Document deprecation rationale for Artifact version constants #11584
+12
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Author
|
Hi, just a gentle reminder. Whenever you get time, please take a look. |
Contributor
Author
|
Just checking in on this PR. It has been idle for a while and is still awaiting workflow approval and review. |
elharo
requested changes
Jan 13, 2026
| * @deprecated since 4.0.0. | ||
| * The use of the {@code RELEASE} version is discouraged because it results | ||
| * in non-reproducible builds. | ||
| * Use an explicit version or a version range instead. |
Contributor
There was a problem hiding this comment.
never use a version range foe the same reasons. Explicit versions only
| public interface Artifact extends Comparable<Artifact> { | ||
|
|
||
| /** | ||
| * @deprecated since 4.0.0. |
| * @deprecated since 4.0.0. | ||
| * The use of the {@code LATEST} version is discouraged because it results | ||
| * in non-reproducible builds. | ||
| * Use an explicit version or a version range instead. |
There was a problem hiding this comment.
Pull request overview
This pull request adds comprehensive JavaDoc documentation to explain the rationale for deprecating the RELEASE and LATEST version constants in the Maven Artifact interface. The constants were previously marked as deprecated in Maven 4.0.0, but lacked explanation.
Changes:
- Added detailed JavaDoc comments explaining that
RELEASEandLATESTversion constants lead to non-reproducible builds - Provided guidance to use explicit versions or version ranges instead
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary:
This pull request documents the rationale for deprecating the Artifact version
constants RELEASE and LATEST.
Why:
The RELEASE and LATEST version constants lead to non-reproducible builds and are
discouraged in Maven 4. This change makes the reason for deprecation explicit
and provides guidance on preferred alternatives.
What:
Scope:
Testing:
Following this checklist to help us incorporate your
contribution quickly and easily:
Note that commits might be squashed by a maintainer on merge.
This may not always be possible but is a best-practice.
mvn verifyto make sure basic checks pass.A more thorough check will be performed on your pull request automatically.
If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.
To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.